GET Assets?assetTypeId={assetTypeId}&assetGroupId={assetGroupId}&parentAssetId={parentAssetId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves assets for the given parameters. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assetTypeId |
Id of the asset type |
globally unique identifier |
None. |
assetGroupId |
Id of the asset group |
globally unique identifier |
None. |
parentAssetId |
Id of the parent asset |
globally unique identifier |
None. |
take |
Number of assets to retrieve. Default is all assets |
integer |
None. |
skip |
Number of assets to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the assets before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of assets.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of Asset |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "AssetId": "7bcf7512-4a58-4dbe-aa7b-97fd40003d79", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "7cb54615-bab5-4ae2-816f-4e20c6669665", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "c182158e-fb38-4513-9ac2-0d5203445702", "CreateDate": "2024-05-04T08:06:26.4329426-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-04T08:06:26.4329426-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "bfa84f4e-5cee-4c54-8361-78ec0558433d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-04T08:06:26.4329426-07:00", "MeasurementValueNeededDate": "2024-05-04T08:06:26.4329426-07:00", "SourceSystemId": "sample string 3", "CompanyId": "f816e32e-8065-4d11-b1ac-8146335c3cf2", "CreateDate": "2024-05-04T08:06:26.4329426-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-04T08:06:26.4329426-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-05-04T08:06:26.4329426-07:00", "MeasurementValueNeededDate": "2024-05-04T08:06:26.4329426-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "e07ade9f-65f2-4231-b35b-194f1421b2e9", "CreateDate": "2024-05-04T08:06:26.4329426-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-04T08:06:26.4329426-07:00", "LastModifiedUser": "sample string 8" }, { "AssetId": "7bcf7512-4a58-4dbe-aa7b-97fd40003d79", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "7cb54615-bab5-4ae2-816f-4e20c6669665", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "c182158e-fb38-4513-9ac2-0d5203445702", "CreateDate": "2024-05-04T08:06:26.4329426-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-04T08:06:26.4329426-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "bfa84f4e-5cee-4c54-8361-78ec0558433d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-04T08:06:26.4329426-07:00", "MeasurementValueNeededDate": "2024-05-04T08:06:26.4329426-07:00", "SourceSystemId": "sample string 3", "CompanyId": "f816e32e-8065-4d11-b1ac-8146335c3cf2", "CreateDate": "2024-05-04T08:06:26.4329426-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-04T08:06:26.4329426-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-05-04T08:06:26.4329426-07:00", "MeasurementValueNeededDate": "2024-05-04T08:06:26.4329426-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "e07ade9f-65f2-4231-b35b-194f1421b2e9", "CreateDate": "2024-05-04T08:06:26.4329426-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-04T08:06:26.4329426-07:00", "LastModifiedUser": "sample string 8" } ], "Total": 1, "Message": "sample string 1" }